home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / sfdistrv.zip / SFDISTRV.DOC < prev    next >
Text File  |  1990-09-15  |  17KB  |  375 lines
  1.                                  
  2.                                 SFDISTRV
  3.                      SPITFIRE POTPOURRI TRIVIA DOOR
  4.                               Version 4.5
  5.                                    by
  6.                               Mary Barnhill
  7.  
  8.    INTRODUCTION
  9.    ------------
  10.                          
  11.       SFDISTRV is a fast paced Disney trivia game designed to run
  12.    as a door feature within the SPITFIRE Bulletin Board System.  It can
  13.    also be installed as a sysop configurable command from the Main, File
  14.    or Message menus of SPITFIRE.  A data file containing over 400 Disney 
  15.    trivia questions is randomly accessed and displayed to the screen.  
  16.    With each question that is displayed, four multiple choice options 
  17.    are provided from which the player may select.  SFDISTRV allows the
  18.    player ten seconds to read the question and respond with the number 
  19.    corresponding to the answer they wish to select.
  20.     
  21.    SFDISTRV SETUP AS A SPITFIRE DOOR
  22.    ---------------------------------
  23.     
  24.       To set up SFDISTRV to be executed as a door, it is recommended that
  25.    a separate directory be set up for it.  For explanation purposes, let's
  26.    assume the directory DOORA is created for use with SFDISTRV.  The following
  27.    files must then be placed in the directory:
  28.    
  29.    SFDISTRV.EXE    The actual game program.
  30.    
  31.    SFDISTRV.DAT    The data file containing the trivia questions.
  32.    
  33.    SFDISTRV.TOP    This is a listing of the top ten players.  SFSPRTRV.EXE
  34.                    will create this file if it is not found. 
  35.                    
  36.    SFDISTRV.LMT    This allows you to set time limits according to the
  37.                    callers security level.
  38.    
  39.    The Sysop will then need to use a text editor to edit the SF.BAT file   
  40.    as illustrated below:
  41.    
  42.    :DOOR_A
  43.    COPY SFDOORS.DAT C:\SF\DOORA
  44.    SFDISTRV
  45.    ERASE SFDOORS.DAT
  46.    GOTO LOOP
  47.    :DOOR_B
  48.      
  49.    You will notice that the commands needed to execute SFDISTRV are placed
  50.    between the :DOOR_A and GOTO LOOP command lines.  These are entered in
  51.    place of the existing REM Place Program Name Here.  The following will 
  52.    briefly explain each of the commands which were set up within SF.BAT to 
  53.    run SFDISTRV as a SPITFIRE Door program:
  54.    
  55.       SFDOORS.DAT is created automatically by SPITFIRE when a user enters a
  56.    door.  It contains information about the user such as name and password.
  57.    SFDISTRV requires access to the information within SFDOORS.DAT.  Therefore,
  58.    before executing the program it must be copied to the directory in which
  59.    SFDISTRV is running.
  60.    
  61.       SFDISTRV is the program name and executes the game program from within
  62.    the door program.
  63.    
  64.       Once the user has terminated the game play of SFDISTRV, SPITFIRE
  65.    erases the SFDOORS.DAT file.
  66.    
  67.    
  68.    SFDISTRV SETUP AS A SYSOP CONFIGURABLE COMMAND
  69.    ----------------------------------------------
  70.  
  71.       SPITFIRE has a sysop configurable command for the Main, Message and
  72.    File menus.  The sysop configurable command is executed through a
  73.    batch file which corresponds to the menu it is being run from.  In
  74.    other words, SFMAIN.BAT runs the sysop configurable command from
  75.    the Main Menu, SFMESS.BAT runs the one from the Message Menu and
  76.    SFFILE.BAT the one from the File Menu.  The commands necessary
  77.    to execute SFDISTRV can be set up in the batch file which corresponds
  78.    to the menu you wish to have SFDISTRV run from.
  79.  
  80.       The first thing you will need to establish is which of these menus
  81.    you wish to use to run SFDISTRV.  For this purpose, let's assume that
  82.    it is going to be set up so it can be run from the Main Menu.  (It
  83.    should be noted the set up procedure is the same regardless of which
  84.    Menu you are running SFDISTRV from.)
  85.  
  86.       Next, you will need to decide what you wish to name the command
  87.    option and establish what security level will be required for
  88.    users of your system to be able to access this option.  Once this
  89.    is determined you will need to modify the SFMAIN.MNU file using
  90.    your favorite text editor, as long as it saves in ASCII format.
  91.    (Refer to the SPITFIRE manual for further documentation on this
  92.    if needed.  It should also be noted that if SFDISTRV were being
  93.    set up to run from the File Menu, you would need to modify the
  94.    SFFILE.MNU file and if it was being set up to be run from the
  95.    Message Menu you would need to modify the SFMSG.MNU file.)
  96.  
  97.       Examining the default SFMAIN.MNU file, you will notice the sysop
  98.    configurable command appears as:
  99.  
  100.         <K>............. Add Your Own,,1000,@
  101.  
  102.       This will need to be replaced with a Command Character that will
  103.    be used to select the option from the menu.  It is ASOLUTELY IMPERATIVE
  104.    that the Command Character must not duplicate an existing Command
  105.    Character for another menu option.  You will then need to include
  106.    a brief description of the Wildcat door program you are running, two
  107.    commas, the security level required to access this feature, and another
  108.    comma followed by the a @.  The @ must not be changed! (For more detailed
  109.    information on modifying your SFMAIN.MNU, SFMSG.MNU or SFFILE.MNU refer
  110.    to your SPITFIRE manual.)
  111.     
  112.        <K>.... Brief Program Description,,10,@
  113.  
  114.       Now you will need to modify the corresponding batch file, SFMAIN.BAT,
  115.    so that it can be executed from the Main Menu.  Do this using your
  116.    favorite text editor, as long as it saves in ASCII format.  (Again, it
  117.    should be noted that if SFDISTRV were being set up to run from the File
  118.    Menu, you would need to modify the SFFILE.BAT file and if it was being
  119.    set up to be run from the Message Menu you would need to modify the
  120.    SFMESS.BAT file.)
  121.  
  122.       Place the SFDISTRV.EXE file in the directory you wish to run the
  123.    program from.  SFDISTRV will create its own player score file,
  124.    SFDISTRV.TOP, if does not already exist.
  125.  
  126.       The commands set up in the SFMAIN.BAT file are very similar to
  127.    those used for executing the game through a door in the SF.BAT file.
  128.    For instance, if you were running SFDISTRV from the main SPITFIRE
  129.    directory your SFMAIN.BAT file might look like this:
  130.  
  131.        ECHO OFF
  132.        BRK OFF
  133.        SFDISTRV
  134.        BRK ON
  135.  
  136.       (BRK is not included in the SFDISTRV package because it is written
  137.    and copyrighted by Solid Systems, 1985, but can be downloaded from
  138.    The Mother Board BBS and Buffalo Creek's BBS as well as a number of 
  139.    other BBS systems.  BRK is not required to run SFDISTRV, however, it
  140.    is recommended since it will prevent a user using the CTRL BRK command 
  141.    to terminate the batch file, gaining access to your system at the 
  142.    DOS level.)
  143.  
  144.       If you wish to set SFDISTRV up in a separate subdirectory from
  145.    SPITFIRE, for instance, a subdirectory named SFDISTRV, your batch
  146.    file might look like this.
  147.  
  148.        ECHO OFF
  149.        BRK OFF
  150.        COPY SFMAIN.DAT \SF\SFDISTRV
  151.        CD \SF\SFDISTRV
  152.        SFDISTRV
  153.        ERASE SFMAIN.DAT
  154.        CD \SF
  155.        BRK ON
  156.  
  157.       When SFDISTRV is executed, from either the door with the SF.BAT file
  158.    or from the sysop configurable command through a menu with the
  159.    corresponding batch file, it will first look for the SFMAIN.DAT file,
  160.    then the SFMESS.DAT file, then the SFFILE.DAT file and lastly the
  161.    SFDOORS.DAT file.  It will look for each of these files until it finds
  162.    it and the commands required for its execution.  If none of these
  163.    files are found, SFDISTRV will halt its execution.
  164.  
  165.    
  166.    DISNEY TRIVIA HIGH SCORE BULLETINS
  167.    -------------------------------------
  168.    
  169.       An command line parameter is available which will automatically
  170.    create Ansi and Non-Ansi high score bulletins for your BBS system.  
  171.    If you would like to use this option, a "/P" should follow the 
  172.    SFDISTRV in the command line to indicate a valid DOS path where the
  173.    bulletin file will be created.   (NOTE:  This should be the same
  174.    as the display file path you have set up within SPITFIRE.)  The path 
  175.    is then followed by the file name of the bulletin to be created.  It 
  176.    is not necessary to include the file extension.  SFDISTRV will
  177.    automatically add a .BBS extension for the Non-Ansi display file and 
  178.    a .CLR extension for the Ansi display file created.  The correct 
  179.    syntax should look like this:
  180.    
  181.    SFDISTRV /P C:\SF\DISPLAY\DORBUL1
  182.    
  183.    The "/P" command line is optional and SFDISTRV will operate perfectly
  184.    fine without it.  However, it is a convenient means of providing and 
  185.    posting high score bulletins for the trivia door.
  186.    
  187.    LOCAL PLAY OF SFDISTRV
  188.    ----------------------
  189.  
  190.       It should also be noted that a Sysop can play SFDISTRV locally by
  191.    entering the following command at the DOS prompt:
  192.    
  193.    C:> SFDISTRV /L
  194.  
  195.     ** SPECIAL NOTE **  The "/L" and the "/P" command parameters can
  196.     be used together in one command line to specify the drive, path
  197.     and filename of the bulletin to be created when playing in
  198.     local mode.
  199.  
  200.    
  201.    SFDISTRV ON A MULTI-NODE SYSTEM
  202.    ------------------------------
  203.    
  204.       SFDISTRV is fully compatible for operation on a multi-node BBS.
  205.    It automatically handles any file locking and file sharing 
  206.    required during the doors execution.   
  207.  
  208.  
  209.    DTE LOCK FEATURE
  210.    ----------------
  211.  
  212.       SFDISTRV automatically detects if the DTE is locked at 19200 baud.  If
  213.    SFDISTRV detects that the DTE is locked, then SFDISTRV opens the serial
  214.    port to the maximum baud rate of your system.  If SFDISTRV does not
  215.    detect that the DTE is locked, then the serial port is opened to the
  216.    baud rate of the caller.
  217.    
  218.  
  219.    SYSOP FEATURES
  220.    --------------
  221.    
  222.        First, a status line is now displayed on the BBS monitor that 
  223.    provides information concerning the caller's name, baud rate of the 
  224.    caller and the security level of the caller.     
  225.    
  226.       A SFDISTRV.LMT file allows the sysop to establish a time limit for
  227.    door play according to the security level the caller has on the system.  
  228.    To modify the accompanying SFDISTRV.LMT file, use your favorite text
  229.    editor to represent the various security levels you have available on 
  230.    your system, a comma then the corresponding time you wish to allow for 
  231.    that particular security level in minutes.  For instance, it might 
  232.    look like this:
  233.    
  234.    10,15
  235.    25,20
  236.    50,25
  237.    999,30
  238.    
  239.    Each security level should begin a new line and you should have a
  240.    setting for each security level you have available on your system.
  241.    If you do not have a time limit set for a particular security 
  242.    SFDISTRV will default to the level 10 security level setting.
  243.    
  244.       Pressing the Shift Key and the F1 key simultaneously will 
  245.    terminate game play of SFDISTRV and return the caller back to the
  246.    BBS.  Pressing the Shift Key and the F9 key simultaneously will
  247.    terminate game play of SFDISTRV and log the caller off of the BBS.
  248.    If the Shift Key and the F9 key are pressed together, logging the
  249.    caller off the BBS, SPITFIRE will recycle and return to the
  250.    SPITFIRE Ready For Caller Prompt.   
  251.             
  252.    SFDISTRV EXECUTION
  253.    ------------------
  254.       
  255.       When first executed, SFDISTRV will display a list of the Top Ten
  256.    high score players and the percentage of correct responses they acheived
  257.    while playing SFDISTRV.  Initially, this will be a dummy listing with
  258.    ten lines that display:
  259.    
  260.       0%...............YOUR NAME COULD BE HERE
  261.       
  262.    However, as the game is played, this will fill with the name of the
  263.    players, their percentage ratings and the date that the player was
  264.    added to the top ten listing.  
  265.    
  266.    NOTE: At least twenty questions must be attempted before SFDISTRV will
  267.          will figure the percentage rating for the player.
  268.          
  269.    To keep things interesting...the Sysop can erase the file which contains
  270.    the top ten listings SFDISTRV.TOP on a routine basis to give additional
  271.    players a chance to have their name added to the list.
  272.    
  273.    As the top ten list is displayed, at the bottom of the screen  is a
  274.    question which prompts the user whether they want to have ANSI Graphics
  275.    (y/n)? available to them during game play.  If the user responds with a
  276.    y (for yes) the game will display in color and if the user responds with
  277.    a n (for no) the game will display in monochrome.
  278.    
  279.    PLAYING SFDISTRV
  280.    ----------------
  281.   
  282.       Immediately after pressing any key (other than <Q> for Quit) from 
  283.    the Top Ten listing the game screen is displayed.  The screen will
  284.    look like the following:
  285.       
  286.    ------------------------------------------------------------------------
  287.  
  288.     ╔══════════════════════════════════════════════╗
  289.     ║    >>>>>>>>>>> DISNEY TRIVIA <<<<<<<<<<<<    ║
  290.     ║                 Version 4.5                  ║
  291.     ║  Disney Trivia Game For SPITFIRE BBS Doors   ║
  292.     ║          VISIONS BBS * (515) 277-1461        ║
  293.     ║ In Cooperation with Buffalo Creek Software   ║
  294.     ║     Copyright (C) by Mary Barnhill, 1989,90  ║
  295.     ║         UNREGISTERED SHAREWARE VERSION!      ║
  296.     ╚══════════════════════════════════════════════╝
  297.        
  298.     RIGHT: 0                        WRONG: 0
  299.      
  300.     QUESTION:
  301.     The Disney trivia question will be displayed
  302.     here.
  303.     
  304.     <1> Choice 1                        <2> Choice 2
  305.     <3> Choice 3                        <4> Choice 4
  306.     
  307.              Enter Answer: [ 1 2 3 4 <Q>uit]?
  308.                        
  309.    -----------------------------------------------------------------------
  310.    
  311.    The first randomly choosen trivia question is selected from the data
  312.    file and is displayed to the screen. 
  313.    
  314.       The player makes his selection by entering the corresponding number.
  315.    As the game progresses, SFDISTRV will provide a running total of the
  316.    correct answers and also of the wrong answers the user has selected
  317.    during the game play.
  318.  
  319.    If the ten second timer should elapse before you respond, SFDISTRV
  320.    will count this as a wrong response and add an incorrect answer to 
  321.    the total WRONG answers obtained so far.
  322.            
  323.    EXITING PLAY
  324.    ------------
  325.    
  326.       When you are ready to exit the game, simply select press "Q" for
  327.    <Q>uit.  If you qualify as one of the top ten players to date, 
  328.    SFDISTRV will congratulate you for becoming one of the top ten scorers
  329.    and add your name to the Top Ten listing.  You will once again see the 
  330.    Top Ten list displayed with your name added to the list.  
  331.    
  332.      If you exit the game before you have completed the twenty
  333.    questions required for eligibility to the Top Ten list or if you do not
  334.    qualify as a Top Ten player, the Top Ten listing will be displayed and 
  335.    you will be prompted to press any key to return to SPITFIRE.
  336.    
  337.    DISTRIBUTION
  338.    ------------
  339.      
  340.       Please feel free to share SFDISTRV.ZIP with others.  However, it must
  341.    be distributed with SFDISTRV.EXE, SFDISTRV.DAT, SFDISTRV.LMT and the
  342.    SFDISTRV.DOC in the SFDISTRV.ZIP distribution package.  These files must
  343.    not be altered in any way or by any means.
  344.    
  345.          SFDISTRV.ZIP is distributed as Shareware software.  You are free to
  346.    try SFDISTRV, and if you find it to be a program you use please send the
  347.    required $10.00 fee to:
  348.    
  349.                              Mary Barnhill
  350.                              1513 - 33rd Street 
  351.                              Des Moines, Iowa  50311
  352.                              
  353.    DISCLAIMER
  354.    ----------
  355.    
  356.       Mary Barnhill shall not be held responsible for any damage incurred
  357.    by the user to hardware, software, or peripheral devices while running
  358.    SFDISTRV.  All responsibility lies in the user of the software.
  359.    
  360.       Many thanks are indeed owed to Mike Woltz of Buffalo Creek BBS (515)-
  361.    225-8496 for his assistance.  Without his help this program would not
  362.    have been possible.   
  363.    
  364.    SFDISTRV and other SPITFIRE programs are available for download from:
  365.    
  366.         Buffalo Creek BBS                     The Mother Board BBS
  367.         Sysop - Mike Woltz                   Sysop - Jacque Shipley
  368.           (515) 225-8496                         (515) 986-3445
  369.        19200/9600/2400/1200                      9800/2400/1200
  370.  
  371.                                VISIONS BBS
  372.                           Sysop - Mary Barnhill
  373.                              (515) 277-1461
  374.                                 1200/2400
  375.